/*
 * Copyright (c) 2003-2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Gabe Black
 */

#ifndef __ARCH_TRIPS_REGISTERS_HH__
#define __ARCH_TRIPS_REGISTERS_HH__

#include "arch/trips/max_inst_regs.hh"
#include "base/types.hh"

namespace TripsISA {

using TripsISAInst::MaxInstSrcRegs;
using TripsISAInst::MaxInstDestRegs;
using TripsISAInst::MaxInstConsumers;
using TripsISAInst::MaxInstOperands;

typedef uint8_t RegIndex;
typedef uint64_t IntReg;

// floating point register file entry type
typedef double FloatReg;
typedef uint64_t FloatRegBits;

// control register file contents
typedef uint64_t MiscReg;

// This is the fraction bits mask
const uint64_t FMASK_D = 0xFFF0000000000000ULL;
const uint32_t  FMASK_S = 0xFF800000;

const uint8_t EXPH_D = 62;
const uint8_t EXPL_D = 52;
const uint8_t EXPH_S = 30;
const uint8_t EXPL_S = 23;

union AnyReg
{
    IntReg  intreg;
    FloatReg   fpreg;
    MiscReg ctrlreg;
};

enum MiscRegIndex
{
    MISCREG_FPCR = 1, // Fix me
    MISCREG_UNIQ,
    MISCREG_LOCKFLAG,
    MISCREG_LOCKADDR,
    MISCREG_INTR
};

// There's no zero reg in trips, so set the reg number to some kind of dummy number
const RegIndex ZeroReg = 128;     

// the rest of these depend on the ABI
const RegIndex StackPointerReg = 1;
//const RegIndex GlobalPointerReg = 11;
//const RegIndex ProcedureValueReg = 27;
const RegIndex ReturnAddressReg = 2;
const RegIndex ReturnValueReg = 3;
const RegIndex FramePointerReg = 12;

const RegIndex SyscallNumReg = 0;
const RegIndex FirstArgumentReg = 3;
const RegIndex SyscallPseudoReturnReg = 4;
const RegIndex SyscallSuccessReg = 3;
const RegIndex SyscallReturnValueReg = 3;
const RegIndex SyscallErrorCodeReg = 4;

const int NumIntArchRegs = 128;
//const int NumPALShadowRegs = 8;
const int NumFloatArchRegs = 128;
// @todo: Figure out what this number really should be.
const int NumMiscArchRegs = 77;

const int NumIntRegs = NumIntArchRegs;
const int NumFloatRegs = NumFloatArchRegs;
const int NumMiscRegs = NumMiscArchRegs ;

const int TotalNumRegs =
    NumIntRegs + NumFloatRegs + NumMiscRegs;

const int TotalDataRegs = NumIntRegs + NumFloatRegs;

// These enumerate all the registers for dependence tracking.
enum DependenceTags {
    // 0..31 are the integer regs 0..31
    // 32..63 are the FP regs 0..31, i.e. use (reg + FP_Base_DepTag)
    FP_Base_DepTag = 40,
    Ctrl_Base_DepTag = 72
};

} // namespace TripsISA

#endif // __ARCH_TRIPS_REGFILE_HH__
